home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Magnum One
/
Magnum One (Mid-American Digital) (Disc Manufacturing).iso
/
d27
/
clnup200.arc
/
CLEANUP.DOC
< prev
next >
Wrap
Text File
|
1991-02-02
|
55KB
|
2,113 lines
CleanUp Version 2.00 Jan 27, 1990 Page 1
1 PURPOSE
CleanUp is a program designed to help you keep your disk clean of all
the temporary, backup and other miscellaneous files that accumulate
during normal processing. CleanUp can delete these files or process
them with any command you choose. CleanUp can also run commands on
each disk and sub-directory to automate your maintenance.
CleanUp uses file specifications that you enter into a control file to
search all the sub-directories on your hard disk for files to process.
You can have CleanUp process the files it finds automatically or
prompt you before processing the file. Any number of specifications
can be entered and any number of sub-directories can be searched
(subject to the amount of memory you have available).
CleanUp can be run in "interactive" mode or from a batch file in
"automatic" mode for use during unattended maintenance.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 2
2 REGISTRATION
CleanUp is copyright (c) Bob Breedlove, 1989, 1990. All rights are
reserved. It is NOT free software. Should you continue to use CleanUp,
please send $10 registration along with your name, address and
telephone number to:
Bob Breedlove
3196 Swallowsnest Dr.
Sacramento, CA 95833
You can use the registration form at the end of this documentation if
you wish. Sorry, registration by phone or credit card not available.
You may use CleanUp on any number of computers that YOU, PERSONALLY
USE. If you are registering CleanUp for a company, you MUST register
CleanUp for each workstation or send a $100.00 site license fee to
allow you to use any number of copies of CleanUp at your SINGLE SITE.
CleanUp may NOT be distributed with other software or as part of any
other package. If you distribute shareware diskettes for money, you
MUST obtain written permission from the author before distributing
CleanUp.
Because of the nature of CleanUp and available time, only registered
users will qualify for support.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 3
3 WARRANTY
CleanUp has been tested as thoroughly as possible. However, there is
no guarantee, either stated or implied that it is suitable for your
specific use or with your specific equipment. The author, Bob
Breedlove, cannot be held responsible for any damage or loss of data
resulting either directly or indirectly from the use of CleanUp.
BEFORE RUNNING CleanUp FOR THE FIRST TIME, BE SURE TO BACKUP ALL
CRITICAL FILES ON YOUR HARD DISK(S). This is especially important
when you first set up your control file.
If you are a registered CleanUp user, you will receive telephone and
mail support for the product. In addition, you will be set up with an
account on BOBsBBS for on-line support.
NON-REGISTERED USERS CANNOT RECEIVE SUPPORT FOR PROBLEMS WITH CleanUp
AND THEIR SPECIFIC EQUIPMENT.
4 A WARNING!
CleanUp has the potential to completely DESTROY your disk. PLEASE
take the precaution of backing up your disk BEFORE you use CleanUp.
This is especially important when you first set up a CleanUp control
file.
5 NETWORK DISKS
CleanUp should work on network disks with some exceptions. CleanUp
has to have access to the sub-directories on your network disks. If
CleanUp cannot get access to the root directory ({drive}:\) then it
cannot process the disk because it cannot construct a list of
sub-directories to process. This situation can happen if the root
directory on your hard disk is protected from access.
CleanUp SHOULD process disks correctly if some of the sub-directories
(other than the root) are protected from access. The protected
directories and their sub-directories will NOT be processed.
Since I do not have access to a network, I cannot test these features
of CleanUp. If you register the software and have problems running it
on your network, I will work with you.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 4
6 FILES
The following files should be on the CleanUp diskette or in the
archive file that you received:
CleanUp.EXE The CleanUp Program
CleanUp.CTL A sample control file.
CleanUp.DOC This documentation
EDITOR.CMD A "cheat sheet" of editor commands.
READ.ME Additional comments, new features
NOTE: The READ.ME file will ONLY be included when there is additional
information about the current release of CleanUp or other BOBsWARE
products which is not included in the documentation (CleanUp.DOC).
If you received these files from a bulletin board system and the file
is not complete or contains other files, BE VERY CAUTIOUS! The
program may have been tampered with.
The only files necessary to run CleanUp are CleanUp.EXE and
CleanUp.CTL or other control file.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 5
7 Starting CleanUp
7.1 Introduction
Before you can run CleanUp, you must create a control file --
default "CleanUp.CTL". See the section -- The Control File --
for details on creating CleanUp.CTL.
CleanUp.EXE and the control file are the only files required to
run CleanUp. They can be placed anywhere on your path. If you are
unfamiliar with the DOS PATH command, please refer to your DOS
documentation.
7.2 The CleanUp Command Line
To run CleanUp, use the following command line:
CleanUp [[{path}]{ControlFileName}] [{switches}]
{ControlFileName} is the name of the control file you wish to
use. If you do NOT enter the control file name, CleanUp will use
"CleanUp.CTL". If you do not enter an extension CleanUp will use
the default extension "CTL".
If you specify a complete path name for the control file, CleanUp
will search ONLY that directory. If you specify ONLY a filename
or do NOT specify the control file name, CleanUp will search the
current directory first. The current directory is the one that
you were in when you started CleanUp. If it can not find the
control file, CleanUp will search the DOS PATH for the file.
If CleanUp cannot find the control file and you have NOT
specified any switches, CleanUp will abort.
The following switches can be entered on the command line:
/E Edit the specified control file (or CleanUp.CTL if none is
specified) and then exit the program WITHOUT processing the
specified patterns and commands.
/R Edit the specified control file (or CleanUp.CTL if none is
specified) and then process the specified patterns and commands.
If either switch is specified, CleanUp will create a new control file
if it can't find the one specified.
NOTE: you can NOT enter a path name without the control filename.
CleanUp will think that the last sub-directory in your path is the
control file and attempt to find that file. For example:
C:\BIN\CleanUp.CTL
is valid, but
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 6
C:\BIN
is NOT. CleanUp will search for a file named "BIN.CTL" in the root
directory on the C: drive.
7.3 Examples
C> CleanUp
CleanUp will search for "CleanUp.CTL" in the current directory.
If it is not found, it will search for a control file with this
name along the DOS path. If "CleanUp.CTL" is not found, the
program will terminate with an error message.
C> CleanUp Weekly.CTL
CleanUp will search for the control file "Weekly.CTL" in the
current directory and along the path. It will terminate with an
error if the file is not found. This control file may be one of
many. Naming control files like this allows you to have one
control file for daily processing and another for weekly or
special processing.
C> CleanUp Weekly
This is the equivalent of the command above. CleanUp will use
the control file "WEEKLY.CTL".
NOTE: if you wish to use a control file without an extension, you
must enter the filename followed by a period. For example, to
use the control name "WEEKLY", enter "CleanUp WEEKLY.".
Note period^
C> CleanUp /E
This version of the command line is used to edit CleanUp.CTL and
then terminate the program. CleanUp will still search for
"CleanUp.CTL" in the current directory and along the path.
However, if it does not find an existing "CleanUp.CTL", it will
create one IN THE CURRENT DIRECTORY.
When CleanUp starts you are placed in the full-screen editor.
When you exit the editor, CleanUp terminates.
Equivalent lines are:
C> CleanUp CleanUp /e
C> CleanUp CleanUp.CTL /e
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 7
C> CleanUp /R
This example is identical to that above ("CleanUp /E") with the
exception that CleanUp will process the control file instructions
once you have exited the editor.
C> CleanUp D:\UTILITY\CleanUp.CTL
When you enter the full path name, CleanUp searches for the file
in the specified directory only. In this case, if CleanUp does
not find "CleanUp.CTL" in the directory "D:\UTILITY", it will
terminate with an error message. This feature allows you to
create control files with the same name in different directories
and process them as desired.
C> CleanUp C:\BIN\Daily.CTL /R
CleanUp will search the directory "C:\BIN" for a control file
called "Daily.CTL". If it does not find one, it will create one
in "C:\BIN". CleanUp will put you in the editor to edit/create
the file and then execute the resulting control file.
C> CleanUp C:\BIN\Daily.CTL /E
This example is identical to the one above except that CleanUp
will NOT execute the instructions in "Daily.CTL" once you exit
the editor.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 8
8 The CONTROL FILE (CleanUp.CTL)
8.1 Introduction
CleanUp's control file(s) is a plain MS-DOS ASCII text file. It
can be created using any text editor or word processor that does
NOT introduce format characters into the text. The easiest way to
create or modify CleanUp.CTL is to use CleanUp's built-in
full-screen text editor.
8.2 Format
The CleanUp control file consists of lines in one of the
following formats:
{session switch}
{disk/directory commands}
{filename pattern} [{switches}] [{command}]
{session switch} is a command switch which affects the entire
CleanUp Process. {switches} which appear on the same line as a
{filename pattern} affect files matching that pattern ONLY.
{disk/directory commands} are commands executed while processing
disks and directories.
NOTE: Only ONE filename pattern per command line is allowed.
Future versions of CleanUp may add features, however, they will
be downward compatible with existing command files.
8.3 Session Switches
Session switches are placed one per command line. They affect the
entire CleanUp session.
8.3.1 /B (Batch Operation)
When the /B session switch is detected, CleanUp will NOT pause
after completing execution. This is useful if you wish to run
CleanUp in unattended mode from a batch file.
8.3.2 /D (Disks to Process)
This switch tells CleanUp which disks to process. If it is not
found, CleanUp will process the current disk. You can list any
number of disks after the switch. The format of this line is:
/D {disk list}
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 9
The {disk list} is in the format of single letters. Do NOT leave
a space between the letters. For example:
/D CD
would process disks C: and D:
/D CDEFG
would process disks C: through G:
/D CDG
would process disks C:, D:, and G: only
NOTE: CleanUp does NOT check to be sure that there are disks in
removable media disk drives. Be sure that you have set up all disks
before starting CleanUp.
8.4 DOS Commands
CleanUp can execute a DOS command, program or batch file at the
following times during processing:
o Just before processing a disk
o Just after processing a disk
o Just before processing a sub-directory
o Just after processing a sub-directory
You may specify a single command for each situation.
(NOTE: CleanUp will execute a command in place of deleting specific
filename patterns. This capability is discussed in the section on
filename patterns.)
The DOS command must be enclosed in quote marks (") when it contains a
space. The general format for these commands is:
/{D|S|P}{+|-} [sub-directory (/P only)] ["]{command}["]
{Command} is executed in a window. Some programs may over-write this
window, however, most DOS commands will execute properly in the
window. CleanUp has been tested with most DOS commands, however,
there is no guarantee that CleanUp can execute a specific program.
The following paragraphs describe each of the command lines.
8.4.1 Command Substitutions
When executing a command, CleanUp will perform substitutions.
These are discussed below. In these discussions, the following
conditions exist for the examples:
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 10
Current Disk: C:
Current Sub-Directory: C:\BIN
Current Filename: TEST.BAK
Current Pattern: *.BAK
%D - Current Disk
Substitutes the drive LETTER only from the current drive. For
example, the command line:
/D+ "SCAN %D:"
would result in CleanUp executing
SCAN C:
When the C: drive is first accessed.
%S - Current Sub-directory
Substitutes the current sub-directory path. For example:
/S+ "CATALOG %S"
would execute
CATALOG C:\BIN
when starting the C:\BIN directory.
%F - Current Filename
Substitutes the current filename and extension in the DOS
command. For example:
*.BAK "COPY $F C:\WORK"
would cause CleanUp to execute:
COPY TEST.BAK C:\WORK
when TEST.BAK was processed instead of deleting the file.
%N - Current Filename--Name Only
Substitutes ONLY the filename (no extension) in the command. For
example:
*.BAK "COPY %F %N.HLD"
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 11
would result in the command:
COPY TEST.BAK TEST.HLD
being executed when TEST.BAK was processed instead of deleting
the file.
%E - Current Filename--Extension Only
Substitutes the file extension only (no filename). For example:
*.BAK "MAINTAIN %N %E"
would pass the filename and extension to the batch file
MAINTAIN.BAT by executing the command line:
MAINTAIN TEST BAK
%P - Current File Pattern
Substitutes the current file pattern in the DOS command. For
example:
*.BAK "MAINTAIN %P"
would pass the file pattern to MAINTAIN.BAT by executing
MAINTAIN *.BAK
8.4.2 Disk/Directory Commands
8.4.2.1 Introduction
This set of commands affects how CleanUp processes disks and
sub-directories. DOS commands can be executed before a
disk/directory is processed ("+") or after a disk/directory has
been processed ("-").
For example, the command line:
/D+ "SCAN %D:"
would execute the program SCAN.EXE BEFORE CleanUp processed the
sub-directories on each disk. The line:
/D- "CATALOG %D:"
would run the program CATALOG.EXE AFTER CleanUp had completed
processing all the sub-directories on a disk.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 12
A single command will be executed when entering and leaving each
disk and sub-directory. If multiple "/D[+|-]" or "/S[+|-]"
commands are entered, only the LAST one will be executed. If you
wish to execute multiple commands, place them in a batch file and
have CleanUp execute that.
8.4.2.2 Naming Sub-Directories
Sub-directories on the /X and /P commands must be entered with
their full disk/directory names. For example:
/X C:\BIN
or
/P+ C:\WORK "CATALOG %S"
are correct. However,
/X \BIN
is NOT correct because it does not include the drive ("C:"). The
full disk and directory name is required because you may have
duplicate sub-directory names on different directories. If only
sub-directory names are considered, CleanUp may process these
sub-directories incorrectly.
8.4.2.3 /D[+|-] (Disk Commands)
Format:
/D[+|-] ["]{DOS Command}["]
This command specifies a DOS command to be executed before ("+")
or after ("-") CleanUp processes each disk.
Examples:
/D+ "SCAN %D:"
/D- "CATALOG"
8.4.2.4 /S[+|-] (General Sub-Directory Commands)
Format:
/S[+|-] ["]{DOS Command}["]
This command will be executed before ("+") or after ("-") CleanUp
processes each directory unless it is overridden by a /P command.
Examples:
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 13
/S+ "MAINTAIN.BAT"
/S- "DOIT %S"
8.4.2.5 /P[+|-] (Specific Sub-Directory Commands)
Format:
/P[+|-] {directory} ["]{DOS Command}["]
Allows you to specify a command that will be executed before
("+") or after ("-") CleanUp processes the specified directory
ONLY. NOTE: This command is executed INSTEAD of the
corresponding /S command for the specified directory.
Examples:
/P+ C:\BIN "SCAN %S"
/P- C:\WORK\TEST "SPECIAL.BAT"
8.4.2.6 /X (Exclude Sub-directory)
Format:
/X {directory}
Specifies that the named directory is to be excluded from
processing. NO processing will be done on this directory.
Examples:
/X C:\HOLD
/X D:\WORK\SPECIAL
/X E:\UPLOAD
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 14
8.5 Filename Patterns
CleanUp uses an extended set of file name matching symbols
(Templates). These allow greater flexibility in the selection of
files to be processed than the standard DOS wildcard characters
("?" and "*"). Only a single filename pattern can be placed on
each line.
8.5.1 File Pattern Line
8.5.2 Template Summary
The following is a summary of template characters that can be used in
filename patterns:
? = Any character
# = Any integer
@ = Any alphabetic character
* = any string of zero or more characters
[] = Groups characters inclusive
[~] = Groups characters exclusive
{|} = Groups of phrases
Each of these template characters is described in detail below.
8.5.3 Template Characters
? [Any Character]
Just as the DOS wildcard character, the question mark ("?")
matches any SINGLE character. The exact number of characters
represented by the "?" must be present to match.
Examples:
???.EXE Matches any file with EXACTLY 3
characters and an extension of EXE. For
example: ABC.EXE, 123.EXE, A2_.EXE. It
would not match AB.EXE or ABCD.EXE.
TEST?.DOC Matches any file with a filename that
consists of "TEST" followed by any
SINGLE character and has an extension of
"DOC". It would match TEST1.DOC or
TESTM.DOC, but NOT TEST12.DOC or
TEST.DOC.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 15
TEST.??? Matches any file whose name is TEST with
a three character extension. Would match
TEST.EXE and TEST.DOC, but would NOT
match TEST.1 or TEST2.DOC.
# [Any Integer]
This template character is the same as the "?" except that it
only matches the numbers 0,1,2,3,4,5,6,7,8,9.
EXAMPLES:
A###.TXT Would match any file name starting with
"A" followed by three numbers and having
the extension "TXT". It would match
"A123.TXT" and "A989.TXT", but not
"ABCD.TXT", "A1.TXT" or "A22A.TXT".
#*.* Would match any file whose name started
with a number.
@ [Any Alphabetic Character]
This template character is the same as the "?" except that it
matches only the alphabetic characters A-Z. Case is ignored.
Examples:
@???.@@@ Would match any file whose name was
exactly 4 characters long and started
with any alphabetic character and whose
extension was composed of exactly three
alphabetic characters. It would match
"A123.ABC" or "ZA2C.TXT", but not
"5ABC.TXT" or "A123.A2C".
T@#*.* Would match any file whose name started
with a "T" followed by any alphabetic
character and any numeric character.
* [Any string of zero or more Characters]
The asterisk ("*") matches any string of zero or more characters.
NOTE: Unlike the DOS "*" this template character can be used
anywhere in the file name or extension.
*.EXE Matches any file with the extension
"EXE".
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 16
TEST*.DOC Matches any file which starts with
"TEST" and has zero or more characters
in the remainder of the filename and has
the extension "DOC". This template would
match TEST.DOC, TEST1.DOC, TESTABC.DOC.
*TEST.* This template would match any file with
TEST as the last four characters of the
filename and any extension. It would
match TEST.DOC, ATEST.EXE, THISTEST.TXT.
It would not match TEST1.DOC.
T*0*.T* This pattern matches any file that
starts with "T", has a "0" somewhere in
the filename and has an extension that
starts with "T". It matches T10.TXT,
T011.T, TXXXXXX0.T00. It would not match
T111.TXT, 1T0.T, T00.XXX.
CAUTION: As with DOS, the "*" can be VERY dangerous. For example,
"*.*" would delete ALL the files from your disk.
[] [Groups characters, inclusive]
[~] [Groups characters, exclusive]
The "[]" pattern allows you to specify characters which are to be
considered in an "or" function. The [~] pattern indicates that
the character must NOT be one of the characters. The "-" is used
to indicate a range of characters. The "," indicates separate
characters. All characters within the "[]" have their literal
meaning.
Examples:
[a-e]*.* Will match any filename starting with
the characters "a","b","c","d", or "e".
It would match ATEST.DOC or DONE.TXT,
but not FRED.DOC.
[a,d,1,@]*.* Will match any filename starting with
the characters "a","d","1" or "@".
Notice that the "@" does NOT have its
meaning in a template.
S[a-d,g,1-3]*.123 Will match any filename starting with
the letter "S" and followed by one of
the characters
"a","b","c","d","g","1","2","3" and
having the extension "123".
[~a-z]*.* Will match any filename NOT starting
with an alphabetic character.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 17
[~a,1,@]*.* Will match any filename NOT starting
with an "a","1", or "@".
{|} [Groups phrases]
Just as the "[]" pattern matches single characters, the "{|}"
pattern matches sets of one or more phrases. The vertical bar
"|" is used to separate the phrases. The phrases to not have to
be the same length.
Examples:
{TO|THE|T2A}*.* Will match filenames starting with "TO",
"THE", or "T2A".
*{XA|XB|TC}.* Will match filenames ending with "XA",
"XB", or "TC".
*.{TMP|TST} Will match filenames with the extensions
"TMP" or "TST".
*{T1|T2|A1|A2}*.* Will match filenames with the phrases
"T1", "T2", "A1" or "A2" somewhere in
their filenames. NOTE, this could also
be entered as "*[A,T][1,2]*.*".
8.6 Pattern Options
Pattern switches apply only to the pattern on the line in which
they are entered. The following switches are recognized:
8.6.1 /V - Verify before processing
The (V)erify switch causes CleanUp to pause and prompt you before
processing a file which matches this pattern. A message is
displayed in the {message area} and the program pauses for input
from the user. If you answer "Y", the file will be processed.
If you answer "N", it will not be processed.
8.6.2 /L - Log file switch
The (L)og switch causes CleanUp to record the individual filename
in the log file. This gives you a permanent record of which
files were processed.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 18
8.6.3 /C - Count only switch
The (C)ount switch causes CleanUp to tally the file, but NOT
process it. This can be useful if you wish only to know how many
of a particular file are on your hard disk. It is also useful
for testing complex patterns to make sure that they process ONLY
the files that you intend.
8.6.4 "{DOS Command}"
A DOS command can be executed instead of deleting the file. This
command must be the LAST thing on the pattern line and MUST be
enclosed in quotes if the DOS command contains spaces. For
example:
*.BAK "COPY %F C:\WORK\%N.OLD"
*.TMP /V "MAINTAIN %N %E"
*.OLD /V/L "MYBAT %F"
are all valid command lines. However,
*.BAK "COPY %F C:\WORK\%N.OLD" /V
*.TMP /V MAINTAIN %F
are NOT valid.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 19
9 The CleanUp Screen
+---------------------------------------------------------------+
| Directory: {directory} |
+-----------------------------+---------------------------------+
|{processed files} | Disks Processed : {count} |
| | Directories Processed : {count} |
| | Files Read : {count} |
| | Files Matched : {count} |
| | Files Deleted : {count} |
| +---------------------------------+
| |{control file name} |
| +---------------------------------+
| |{control file patterns} |
| |{final statistics} |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
+-----------------------------+ |
|{messages and prompts} | |
| | |
+-----------------------------+---------------------------------+
Cleanup version {version} (c) Bob Breedlove 1989,1990
While cleanup is processing, it displays the CleanUp control
screen. This screen displays information about the session. It
is also used to prompt for information from the user, if
required. The following briefly describes each area on the
screen.
{directory} Directory being processed.
{processed files} Lists files as they are
deleted/processed.
{count} Lists count of files in category while
processing.
{control file name} The control file name including path.
{control file patterns}
{final statistics} During processing, this section lists
the control file patterns. After
processing is complete, it displays a
set of final statistics for the session.
{messages and prompts} Displays general messages and prompts
during processing.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 20
For a description of the messages and prompts displayed during
processing see the section on "Messages" at the end of this
documentation.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 21
10 The log file (CleanUp.LOG)
CleanUp maintains a log file. By default, this file is called
CleanUp.LOG. It is stored in the same sub-directory where
CleanUp found the control file. The file is a plain ASCII text
file and can be listed, edited or printed. The log file name
will be the same as the name of the control file used with an
extension of "LOG". For example: if your control file is
"DAILY.CTL" then the log file will be "DAILY.LOG".
NOTE: CleanUp will write over any existing log files. If you
wish to keep track of previous CleanUp sessions, you will have to
rename the log file to a different name or copy the log file to a
different directory before running CleanUp.
10.1 Sample Log File
CleanUp version 2.00 started : 01/20/90 at 12:51:23
Control File:
Disks : C
*.BAK /L
*.TMP /V
*.[&,~]*
*.??$
*.O
TEST.BAK deleted
DOCUMENT.BAK deleted
RESTORE.BAK deleted
Num Bytes Num Bytes
Pattern Matched Matched Deleted Deleted
*.BAK 3 16835 3 16835
*.TMP 0 0 0 0
*.[&,~]* 0 0 0 0
*.??$ 0 0 0 0
*.O 0 0 0 0
Disks Processed : 1
Dirs Processed : 43
Files Read : 888
Bytes Read : 17911920
Files Matched : 3
Bytes Matched : 16835
Files Deleted : 3
Bytes Deleted : 16835
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 22
10.2 Log File Contents
10.2.1 Log File Header
The log file header contains the CleanUp version number. This
number is important when reporting problems with your registered
version of CleanUp.
The header also shows the date and time that CleanUp was run.
These are taken from the computer's clock and will only be as
accurate as the clock.
10.2.2 CleanUp Control File Patterns
CleanUp then displays the control file name and its contents.
This section in the log file contains the patterns and control
switches found in the control file.
10.2.3 File Processing Log
If you have told CleanUp to log files that it finds and processes
(/L switch), this section contains a list of these filenames.
10.2.4 Pattern Counts
CleanUp next displays the counts and total bytes matched and
processed (deleted) for each of the file patterns.
10.2.5 Total Counts
The log ends with the total processing count display. This is
the same display which is shown in the lower right-hand window on
the CleanUp screen.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 23
11 The Full Screen Editor
CleanUp has a full-screen editor which can be used to edit the
control file. It can handle files up to 64K in size. The editor
uses commands very similar to WordStar (tm). The file EDITOR.CMD
contains the commands. To print this "cheat sheet", you can use
the command:
COPY EDITOR.CMD PRN
Be sure that your printer is on before you issue this command.
11.1 Editing the Control File
To edit the control file, start CleanUp with the "/E" or "/R"
switches. See the discussion above for more information on these
command line switches.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 24
12 Tips and Cautions
12.1 The DOS Path
Because CleanUp searches first in the current directory and then
along the DOS PATH for the control file, you can have multiple
control files in different sub-directories for various
situations. In fact, you can have different control files with
the SAME NAME in different sub-directories. If you do, however,
it is important that you realize where you have started CleanUp
and what your DOS path is! UNLESS YOU SPECIFY THE FULL PATH NAME,
CleanUp WILL EXECUTE THE FIRST CONTROL FILE IT FINDS THAT MATCHES
YOUR COMMAND LINE!
For example, given the following sub-directory structure:
C:\
+----C:\BIN
| CleanUp.CTL
+----C:\WORK
| CleanUp.CTL
+----C:\TEST
| CleanUp.CTL
+----C:\MYDIR
and the following DOS path
C:\BIN;C:\WORK
starting CleanUp from the following directories will use the
indicated CleanUp.CTL file:
Start Directory Control File
C:\ C:\BIN\CleanUp.CTL
C:\BIN C:\BIN\CleanUp.CTL
C:\TEST C:\TEST\CleanUp.CTL
C:\WORK C:\WORK\CleanUp.CTL
C:\MYDIR C:\BIN\CleanUp.CTL
Note that even though "C:\WORK\CleanUp.CTL" is along the DOS Path, it
will not be used unless specified explicitly or CleanUp is started
from that sub-directory. This is because the path is searched on the
order entered and CleanUp will always find "CleanUp.CTL" in the
"C:\BIN" directory first and use it.
12.2 Filename Patterns
CleanUp will process faster and use less memory if you combine
patterns. For example, if you wish to delete all files with
extensions of "BAK" and "TMP", you could enter either:
*.BAK
*.TMP
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 25
or
*.{BAK|TMP}
in the control file. Both will do the job, but the second will
use somewhat less memory and will process somewhat faster. The
first command lines will count the file types separately while
the second will give you a total count for both types of files.
You might also want to process all files starting with the
letters "A", "B", or "D". You could enter:
A*.*
B*.*
D*.*
This would count each type of file separately. However, you could
also enter:
[a,b,d]*.*
and get somewhat faster processing.
12.3 Using the /C pattern switch
When you first test a control file, you might want to use the /C
switch to count the files matching the pattern without deleting
them. This will allow you to verify that only the files that you
want to process are actually processed by CleanUp. Once you've
seen that the control file works correctly, remove the switch and
process the disk.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 26
13 Capacities
CleanUp does not limit the number of patterns or sub-directories
that you can process. However, CleanUp does use memory to store
"lists" used to process files. If you have a large number of
sub-directories or patterns, and a small amount of memory,
CleanUp may not function. To make more memory available:
o Remove any memory-resident programs
o Remove any menuing programs that are in memory
It is highly unlikely that you will run out of memory if you have done
these two things.
14 Messages
This section contains a description of the messages produced by
CleanUp during processing. They are arranged in alphabetical
order.
Abort Operation (y/N)?
This message appears when you have pressed a key during
CleanUp operation. CleanUp pauses when possible and asks if
you wish to interrupt processing. Press "Y" to abort
processing. If you enter "N" or press <Enter>, processing
will continue.
ABORTED : {Message}
CleanUp has aborted for some reason. {message} describes
the reason that CleanUp aborted.
Batch Processing
Appears in the Log File when you have specified batch
processing ("/B").
Cannot Get Current Directory!
CleanUp is unable to obtain the name of the current
directory. This is a fatal condition.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 27
Cleanup version {Version} (c) Bob Breedlove 1989,90
This is the "banner" message for CleanUp. It appears at the
top of the CleanUp control screen. The important thing on
this message is the {version}. Registered users will need
this when calling for support.
CleanUp version {Version} started : {date} at {time}
Log File Message. The {date} and {time} are taken from the
system clock. They will only be as accurate as this clock.
Control File: unable to open {ControlFileName}
Displayed if CleanUp is unable to locate the control file.
{ControlFileName} indicates the name CleanUp was attempting
to find. Check to make sure that you entered the correct
name and that this control file is located somewhere on your
DOS PATH.
Control File: {ControlFileName}
Records the name of the control file in the log file.
Delete/Process File (Y/N)?
Prompt displayed for each file matching a pattern with the
"/V" pattern switch. Press "Y" to delete or process the
file, press "N" to skip the file.
Dir Com {In|Out} : {Directory} - {Command}
This message is recorded in the log file when you have
specified a command for a specific directory using
"/P[+|-]".
{In|Out} indicates whether this command was
executed before ("+") or after
("-") processing the directory.
{directory} the full path name of the
directory.
{command} the command line as you entered it.
Dir {In|Out} : {Command}
Written to the Log File when you specify a command to be
executed before ("+") or after ("-") processing each
directory ("/S{+|-}").
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 28
Directory {In|Out} : {command}
CleanUp displays the DOS command being executed when you
start ("In") or complete ("Out") directory processing at the
top of the execution window. The DOS command shows the
expanded substitution variables.
Disk {In|Out} : {command}
CleanUp displays the DOS command being executed when you
start ("In") or complete ("Out") processing a disk at the
top of the execution window. The DOS command shows the
expanded substitution variables.
Disk {In|Out} : {Command}
Written to the Log File when you specify a command to be
executed before ("+") or after ("-") processing each disk
("/S{+|-}").
Disks : {Disks}
Logs the disks processed. These are the disks listed on the
"/D" session switch.
Editing Complete
Indicates a successful editing session initiated with the
"/E" command line switch.
Error executing DOS: {result}
CleanUp has received an error while trying to execute an
external DOS command ("{result}").
{result} can be:
2 File not found
8 Not enough memory (the most common)
10 Invalid environment
11 Invalid format
Exclude: {directory}
Entered in the log file when you have specified a
{directory} to exclude for processing ("/X").
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 29
Excluded: {Directory}
CleanUp logs the name of any directory which you have
excluded from processing.
Filename deleted
CleanUp has successfully deleted the indicated file.
Filename not deleted/processed
This message is displayed on the screen and recorded in the
log file. You specified the verify parameter ("/V") and
answered "N" (no) to the prompt.
Filename unable to delete
CleanUp was not able to delete a file which matched one of
the patterns. This can be caused by read-only file
attributes or share locking in a network environment.
Finding Directories
Please wait . . .
Displayed while CleanUp is reading all directories on the
disk. CleanUp first scans each disk for all directories
then processes them from an internal list.
Loading Control File.
Please wait . . .
Displayed in the message area while CleanUp is loading the
control file.
PROCESSING COMPLETE
Press ANY key . . .
Displayed in the {message area} when CleanUp has completed
processing unless the "/B" system switch has been entered.
CleanUp pauses until you press any key.
Processing {Filename} : {command}
CleanUp displays the DOS command being executed at the top
of the execution window when you have specified a command to
be run rather than deleting a file. The DOS command shows
the expanded substitution variables.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 30
Processing,
Please wait . . .
Message displayed in the {messages and prompts} area of the
CleanUp screen during processing.
Program aborted by operator!
Message is displayed if you abort program operation by
pressing any key and then answering "Y" to the "Abort
Operation" prompt.
Unable to access : {Root Directory}
CleanUp is unable to access the specified root directory.
Because CleanUp cannot process the root directory, it is
unable to process the entire disk.
Unable to change to {Directory}
While processing, CleanUp was unable to change to the
indicated directory ("cd {directory}"). This is considered
a fatal error since CleanUp WAS able to change to the
directory to place it on the working list. This error may
be caused by directory "locking" in a multi-tasking or
network environment. CleanUp must have access to all
directories you have asked it to process.
Unable to create command window
CleanUp attempted to create a window in which to run an
external command but was unable to do so. This is usually
caused by too little memory. Try removing one or more TSR
program from memory and start CleanUp again.
Unable to create edit window
While trying to edit the control file, CleanUp was unable to
create the edit window. This is usually an indication of
too little available memory.
Unable to display edit window
While trying to edit the control file, CleanUp was unable to
display the edit window. This is usually an indication of
too little available memory.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 31
Unable to execute external command for {Heading}
CleanUp was unable to create the window and execute a
command for the {heading} process. Heading will contain the
name of the process ("Disk In", "Directory In", etc.) and
the command that it was trying to execute. This abort
message is usually indicative of too little memory.
Unable to initialize editor
CleanUp was unable to initialize the edit buffers to edit
the control file. This is usually an indication that you do
not have enough free memory.
Unable to open LogFile
CleanUp was unable to open the log file. CleanUp attempts
to place the log file in the same sub-directory as the
control file. Be sure that this is NOT a protected
directory.
Unable to save {ControlFileName}
CleanUp was unable to save the control file after you edited
it. This is usually a result of removing a diskette on
which the file was located or some action taken over a
network.
{ControlFileName} too large to edit!
The control file is larger than 64K. This is highly
unlikely with CleanUp's control file. You are probably
pointing to a file which is NOT a CleanUp control file.
{Filename} processed
CleanUp displays this message when it has completed
processing a file for which you have specified a DOS
command. If required, it will also log the message to the
log file.
Copyright Bob Breedlove 1989,90 All rights reserved
CleanUp Version 2.00 Jan 27, 1990 Page 32
15 Registration Form
To register CleanUp, send $5.00 and this completed registration
form to:
Bob Breedlove
3196 Swallowsnest Dr.
Sacramento, CA 95833
You will receive confirmation of your registration and support
instructions by return mail. When the new version of CleanUp is
released, you will receive if FREE OF CHARGE! Thanks for
registering CleanUp.
Name: __________________________________________________
Address: __________________________________________________
__________________________________________________
City: ___________________________ State: ___ Zip: ______
Phone: (______) _____-_______ extension _________________
The following information is optional, however, it will help me
provide you with assistance should you need support to use
CleanUp.
Computer: __________________________________________________
Type: 808X____ 80286____ 80386____ Other_____________
Memory: ___________________
Graphics: CGA__ VGA__ EGA__ B/W__ Hercules__
Copyright Bob Breedlove 1989,90 All rights reserved